org.eclipse.vtp.framework.interactions.voice.vxml
Class Parameter

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.Parameter

All Implemented Interfaces:

VXMLConstants

public class Parameter
extends Widget
implements VXMLConstants

The Parameter class represents the <param> VXML element. Certain VXML elements require data to be passed in Parameter objects. The Subdialog element requires any variables in the current dialog you want to perform operations on must be passed as Parameter elements.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

protected java.lang.String	name The name of this parameter.
protected java.lang.String	value The value of this parameter.

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

Parameter(java.lang.String name, java.lang.String value)
Creates a new Parameter.

Method Summary

java.lang.String	getName() Returns the name of this parameter.
java.lang.String	getValue() Returns the value of this parameter.
void	setName(java.lang.String name) Sets the name of this parameter.
void	setValue(java.lang.String value) Sets the value of this parameter.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this parameter to the supplied set.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

protected java.lang.String name

The name of this parameter.

value

protected java.lang.String value

The value of this parameter.

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value)
          throws java.lang.IllegalArgumentException,
                 java.lang.NullPointerException

Creates a new Parameter.

Parameters:

name - The name of this parameter.

value - The value of this parameter.

Throws:

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.IllegalArgumentException - If the supplied value is empty.

java.lang.NullPointerException - If the supplied name is null.

java.lang.NullPointerException - If the supplied value is null.

Method Detail

getName

public java.lang.String getName()

Returns the name of this parameter.

Returns:

The name of this parameter.

getValue

public java.lang.String getValue()

Returns the value of this parameter.

Returns:

The value of this parameter.

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalArgumentException,
                    java.lang.NullPointerException

Sets the name of this parameter.

Parameters:

name - The name of this parameter.

Throws:

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.NullPointerException - If the supplied name is null.

setValue

public void setValue(java.lang.String value)
              throws java.lang.IllegalArgumentException,
                     java.lang.NullPointerException

Sets the value of this parameter.

Parameters:

value - The value of this parameter.

Throws:

java.lang.IllegalArgumentException - If the supplied value is empty.

java.lang.NullPointerException - If the supplied value is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Write the attribute members of this parameter to the supplied set.

Parameters:

attributes - The attribute set to write to.

Throws:

java.lang.NullPointerException - If the supplied attribute set is null.